﻿// ------------------------------------------------------------------------
// 项目名称：Canroc.Net 
// 版权归属：Canroc（https://gitee.com/canroc）
//
// 许可证信息
// Canroc.Net项目主要遵循 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-APACHE 文件。
//
// 使用条款：
// 1.使用本项目应遵守相关法律法规和许可证的要求。
// 2.不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动。
// 3.任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任
//
// 免责声明
// 对于因使用本代码而产生的任何直接、间接、偶然、特殊或后果性损害，我们不承担任何责任。
//
// 其他重要信息
// Canroc.Net 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。
// ------------------------------------------------------------------------

namespace Canroc.Net.Core.Helper;

/// <summary>
///     RESTful结果帮助类
/// </summary>
public static class RestfulResultHelper
{
    /// <summary>
    ///     响应成功消息
    /// </summary>
    /// <param name="statusCode">成功响应码</param>
    /// <param name="data">返回数据</param>
    /// <param name="message">成功信息</param>
    /// <returns></returns>
    public static RestfulResultModel<object> SuccessMessage(HttpStatusCodeEnum statusCode, string message,
        object? data = null)
    {
        return new RestfulResultModel<object>
        {
            Code = statusCode,
            Success = true,
            Data = data,
            Msg = message,
            Extras = null
        };
    }

    /// <summary>
    ///     响应错误消息
    /// </summary>
    /// <param name="statusCode">错误响应码</param>
    /// <param name="message">错误信息</param>
    /// <param name="extrasData">额外信息</param>
    /// <returns></returns>
    public static RestfulResultModel<object> ErrorMessage(HttpStatusCodeEnum statusCode, string message,
        object? extrasData = null)
    {
        return new RestfulResultModel<object>
        {
            Code = statusCode,
            Success = false,
            Data = null,
            Msg = message,
            Extras = extrasData
        };
    }
}